<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.beanutils.converters;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.commons.beanutils.ConversionException;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    /**<a name="line.21"></a>
<FONT color="green">022</FONT>     * {@link org.apache.commons.beanutils.Converter} implementaion that handles conversion<a name="line.22"></a>
<FONT color="green">023</FONT>     * to and from &lt;b&gt;Boolean&lt;/b&gt; objects.<a name="line.23"></a>
<FONT color="green">024</FONT>     * {@link org.apache.commons.beanutils.Converter} implementaion that<a name="line.24"></a>
<FONT color="green">025</FONT>     * handles conversion to and from &lt;b&gt;java.lang.Boolean&lt;/b&gt; objects.<a name="line.25"></a>
<FONT color="green">026</FONT>     * &lt;p&gt;<a name="line.26"></a>
<FONT color="green">027</FONT>     * Can be configured to either return a &lt;i&gt;default value&lt;/i&gt; or throw a<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;code&gt;ConversionException&lt;/code&gt; if a conversion error occurs.<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;p&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>     * By default any object whose string representation is one of the values<a name="line.30"></a>
<FONT color="green">031</FONT>     * {"yes", "y", "true", "on", "1"} is converted to Boolean.TRUE, and <a name="line.31"></a>
<FONT color="green">032</FONT>     * string representations {"no", "n", "false", "off", "0"} are converted<a name="line.32"></a>
<FONT color="green">033</FONT>     * to Boolean.FALSE. The recognised true/false strings can be changed by:<a name="line.33"></a>
<FONT color="green">034</FONT>     * &lt;pre&gt;<a name="line.34"></a>
<FONT color="green">035</FONT>     *  String[] trueStrings = {"oui", "o", "1"};<a name="line.35"></a>
<FONT color="green">036</FONT>     *  String[] falseStrings = {"non", "n", "0"};<a name="line.36"></a>
<FONT color="green">037</FONT>     *  Converter bc = new BooleanConverter(trueStrings, falseStrings);<a name="line.37"></a>
<FONT color="green">038</FONT>     *  ConvertUtils.register(bc, Boolean.class);<a name="line.38"></a>
<FONT color="green">039</FONT>     *  ConvertUtils.register(bc, Boolean.TYPE);<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;/pre&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * In addition, it is recommended that the BooleanArrayConverter also be<a name="line.41"></a>
<FONT color="green">042</FONT>     * modified to recognise the same set of values:<a name="line.42"></a>
<FONT color="green">043</FONT>     * &lt;pre&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     *   Converter bac = new BooleanArrayConverter(bc, BooleanArrayConverter.NO_DEFAULT);<a name="line.44"></a>
<FONT color="green">045</FONT>     *   ConvertUtils.register(bac, bac.MODEL);<a name="line.45"></a>
<FONT color="green">046</FONT>     * &lt;/pre&gt;<a name="line.46"></a>
<FONT color="green">047</FONT>     * &lt;/p&gt;<a name="line.47"></a>
<FONT color="green">048</FONT>     * <a name="line.48"></a>
<FONT color="green">049</FONT>     * &lt;p&gt;Case is ignored when converting values to true or false.&lt;/p&gt;<a name="line.49"></a>
<FONT color="green">050</FONT>     *<a name="line.50"></a>
<FONT color="green">051</FONT>     * @author Craig R. McClanahan<a name="line.51"></a>
<FONT color="green">052</FONT>     * @version $Revision: 640131 $ $Date: 2008-03-23 02:10:31 +0000 (Sun, 23 Mar 2008) $<a name="line.52"></a>
<FONT color="green">053</FONT>     * @since 1.3<a name="line.53"></a>
<FONT color="green">054</FONT>     */<a name="line.54"></a>
<FONT color="green">055</FONT>    public final class BooleanConverter extends AbstractConverter {<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>    <a name="line.57"></a>
<FONT color="green">058</FONT>        // ----------------------------------------------------------- Constructors<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>        /**<a name="line.61"></a>
<FONT color="green">062</FONT>         * Create a {@link org.apache.commons.beanutils.Converter} that will throw a {@link ConversionException}<a name="line.62"></a>
<FONT color="green">063</FONT>         * if a conversion error occurs, ie the string value being converted is<a name="line.63"></a>
<FONT color="green">064</FONT>         * not one of the known true strings, nor one of the known false strings.<a name="line.64"></a>
<FONT color="green">065</FONT>         */<a name="line.65"></a>
<FONT color="green">066</FONT>        public BooleanConverter() {<a name="line.66"></a>
<FONT color="green">067</FONT>            super();<a name="line.67"></a>
<FONT color="green">068</FONT>        }<a name="line.68"></a>
<FONT color="green">069</FONT>    <a name="line.69"></a>
<FONT color="green">070</FONT>    <a name="line.70"></a>
<FONT color="green">071</FONT>        /**<a name="line.71"></a>
<FONT color="green">072</FONT>         * Create a {@link org.apache.commons.beanutils.Converter} that will return the specified default value<a name="line.72"></a>
<FONT color="green">073</FONT>         * if a conversion error occurs, ie the string value being converted is<a name="line.73"></a>
<FONT color="green">074</FONT>         * not one of the known true strings, nor one of the known false strings.<a name="line.74"></a>
<FONT color="green">075</FONT>         *<a name="line.75"></a>
<FONT color="green">076</FONT>         * @param defaultValue The default value to be returned if the value<a name="line.76"></a>
<FONT color="green">077</FONT>         *  being converted is not recognised. This value may be null, in which<a name="line.77"></a>
<FONT color="green">078</FONT>         *  case null will be returned on conversion failure. When non-null, it is<a name="line.78"></a>
<FONT color="green">079</FONT>         *  expected that this value will be either Boolean.TRUE or Boolean.FALSE.<a name="line.79"></a>
<FONT color="green">080</FONT>         *  The special value BooleanConverter.NO_DEFAULT can also be passed here,<a name="line.80"></a>
<FONT color="green">081</FONT>         *  in which case this constructor acts like the no-argument one.<a name="line.81"></a>
<FONT color="green">082</FONT>         */<a name="line.82"></a>
<FONT color="green">083</FONT>        public BooleanConverter(Object defaultValue) {<a name="line.83"></a>
<FONT color="green">084</FONT>            super();<a name="line.84"></a>
<FONT color="green">085</FONT>            if (defaultValue != NO_DEFAULT) {<a name="line.85"></a>
<FONT color="green">086</FONT>                setDefaultValue(defaultValue);<a name="line.86"></a>
<FONT color="green">087</FONT>            }<a name="line.87"></a>
<FONT color="green">088</FONT>        }<a name="line.88"></a>
<FONT color="green">089</FONT>    <a name="line.89"></a>
<FONT color="green">090</FONT>        /**<a name="line.90"></a>
<FONT color="green">091</FONT>         * Create a {@link org.apache.commons.beanutils.Converter} that will throw a {@link ConversionException}<a name="line.91"></a>
<FONT color="green">092</FONT>         * if a conversion error occurs, ie the string value being converted is<a name="line.92"></a>
<FONT color="green">093</FONT>         * not one of the known true strings, nor one of the known false strings.<a name="line.93"></a>
<FONT color="green">094</FONT>         * &lt;p&gt;<a name="line.94"></a>
<FONT color="green">095</FONT>         * The provided string arrays are copied, so that changes to the elements<a name="line.95"></a>
<FONT color="green">096</FONT>         * of the array after this call is made do not affect this object.<a name="line.96"></a>
<FONT color="green">097</FONT>         *<a name="line.97"></a>
<FONT color="green">098</FONT>         * @param trueStrings is the set of strings which should convert to the<a name="line.98"></a>
<FONT color="green">099</FONT>         *  value Boolean.TRUE. The value null must not be present. Case is<a name="line.99"></a>
<FONT color="green">100</FONT>         *  ignored.<a name="line.100"></a>
<FONT color="green">101</FONT>         *<a name="line.101"></a>
<FONT color="green">102</FONT>         * @param falseStrings is the set of strings which should convert to the<a name="line.102"></a>
<FONT color="green">103</FONT>         *  value Boolean.TRUE. The value null must not be present. Case is<a name="line.103"></a>
<FONT color="green">104</FONT>         *  ignored.<a name="line.104"></a>
<FONT color="green">105</FONT>         */<a name="line.105"></a>
<FONT color="green">106</FONT>        public BooleanConverter(String[] trueStrings, String[] falseStrings) {<a name="line.106"></a>
<FONT color="green">107</FONT>            super();<a name="line.107"></a>
<FONT color="green">108</FONT>            this.trueStrings = copyStrings(trueStrings);<a name="line.108"></a>
<FONT color="green">109</FONT>            this.falseStrings = copyStrings(falseStrings);<a name="line.109"></a>
<FONT color="green">110</FONT>        }<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>        /**<a name="line.112"></a>
<FONT color="green">113</FONT>         * Create a {@link org.apache.commons.beanutils.Converter} that will return<a name="line.113"></a>
<FONT color="green">114</FONT>         * the specified default value if a conversion error occurs.<a name="line.114"></a>
<FONT color="green">115</FONT>         * &lt;p&gt;<a name="line.115"></a>
<FONT color="green">116</FONT>         * The provided string arrays are copied, so that changes to the elements<a name="line.116"></a>
<FONT color="green">117</FONT>         * of the array after this call is made do not affect this object.<a name="line.117"></a>
<FONT color="green">118</FONT>         *<a name="line.118"></a>
<FONT color="green">119</FONT>         * @param trueStrings is the set of strings which should convert to the<a name="line.119"></a>
<FONT color="green">120</FONT>         *  value Boolean.TRUE. The value null must not be present. Case is<a name="line.120"></a>
<FONT color="green">121</FONT>         *  ignored.<a name="line.121"></a>
<FONT color="green">122</FONT>         *<a name="line.122"></a>
<FONT color="green">123</FONT>         * @param falseStrings is the set of strings which should convert to the<a name="line.123"></a>
<FONT color="green">124</FONT>         *  value Boolean.TRUE. The value null must not be present. Case is<a name="line.124"></a>
<FONT color="green">125</FONT>         *  ignored.<a name="line.125"></a>
<FONT color="green">126</FONT>         *<a name="line.126"></a>
<FONT color="green">127</FONT>         * @param defaultValue The default value to be returned if the value<a name="line.127"></a>
<FONT color="green">128</FONT>         *  being converted is not recognised. This value may be null, in which<a name="line.128"></a>
<FONT color="green">129</FONT>         *  case null will be returned on conversion failure. When non-null, it is<a name="line.129"></a>
<FONT color="green">130</FONT>         *  expected that this value will be either Boolean.TRUE or Boolean.FALSE.<a name="line.130"></a>
<FONT color="green">131</FONT>         *  The special value BooleanConverter.NO_DEFAULT can also be passed here,<a name="line.131"></a>
<FONT color="green">132</FONT>         *  in which case an exception will be thrown on conversion failure.<a name="line.132"></a>
<FONT color="green">133</FONT>         */<a name="line.133"></a>
<FONT color="green">134</FONT>        public BooleanConverter(String[] trueStrings, String[] falseStrings, <a name="line.134"></a>
<FONT color="green">135</FONT>                    Object defaultValue) {<a name="line.135"></a>
<FONT color="green">136</FONT>            super();<a name="line.136"></a>
<FONT color="green">137</FONT>            this.trueStrings = copyStrings(trueStrings);<a name="line.137"></a>
<FONT color="green">138</FONT>            this.falseStrings = copyStrings(falseStrings);<a name="line.138"></a>
<FONT color="green">139</FONT>            if (defaultValue != NO_DEFAULT) {<a name="line.139"></a>
<FONT color="green">140</FONT>                setDefaultValue(defaultValue);<a name="line.140"></a>
<FONT color="green">141</FONT>            }<a name="line.141"></a>
<FONT color="green">142</FONT>        }<a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>    <a name="line.144"></a>
<FONT color="green">145</FONT>        // ----------------------------------------------------- Static Variables<a name="line.145"></a>
<FONT color="green">146</FONT>    <a name="line.146"></a>
<FONT color="green">147</FONT>    <a name="line.147"></a>
<FONT color="green">148</FONT>        /**<a name="line.148"></a>
<FONT color="green">149</FONT>         * This is a special reference that can be passed as the "default object"<a name="line.149"></a>
<FONT color="green">150</FONT>         * to the constructor to indicate that no default is desired. Note that<a name="line.150"></a>
<FONT color="green">151</FONT>         * the value 'null' cannot be used for this purpose, as the caller may<a name="line.151"></a>
<FONT color="green">152</FONT>         * want a null to be returned as the default.<a name="line.152"></a>
<FONT color="green">153</FONT>         * @deprecated Use constructors without default value.<a name="line.153"></a>
<FONT color="green">154</FONT>         */<a name="line.154"></a>
<FONT color="green">155</FONT>        public static final Object NO_DEFAULT = new Object();<a name="line.155"></a>
<FONT color="green">156</FONT>    <a name="line.156"></a>
<FONT color="green">157</FONT>    <a name="line.157"></a>
<FONT color="green">158</FONT>        // ----------------------------------------------------- Instance Variables<a name="line.158"></a>
<FONT color="green">159</FONT>    <a name="line.159"></a>
<FONT color="green">160</FONT>        /**<a name="line.160"></a>
<FONT color="green">161</FONT>         * The set of strings that are known to map to Boolean.TRUE.<a name="line.161"></a>
<FONT color="green">162</FONT>         */<a name="line.162"></a>
<FONT color="green">163</FONT>        private String[] trueStrings = {"true", "yes", "y", "on", "1"};<a name="line.163"></a>
<FONT color="green">164</FONT>    <a name="line.164"></a>
<FONT color="green">165</FONT>        /**<a name="line.165"></a>
<FONT color="green">166</FONT>         * The set of strings that are known to map to Boolean.FALSE.<a name="line.166"></a>
<FONT color="green">167</FONT>         */<a name="line.167"></a>
<FONT color="green">168</FONT>        private String[] falseStrings = {"false", "no", "n", "off", "0"};<a name="line.168"></a>
<FONT color="green">169</FONT>    <a name="line.169"></a>
<FONT color="green">170</FONT>        // --------------------------------------------------------- Protected Methods<a name="line.170"></a>
<FONT color="green">171</FONT>    <a name="line.171"></a>
<FONT color="green">172</FONT>        /**<a name="line.172"></a>
<FONT color="green">173</FONT>         * Return the default type this &lt;code&gt;Converter&lt;/code&gt; handles.<a name="line.173"></a>
<FONT color="green">174</FONT>         *<a name="line.174"></a>
<FONT color="green">175</FONT>         * @return The default type this &lt;code&gt;Converter&lt;/code&gt; handles.<a name="line.175"></a>
<FONT color="green">176</FONT>         */<a name="line.176"></a>
<FONT color="green">177</FONT>        protected Class getDefaultType() {<a name="line.177"></a>
<FONT color="green">178</FONT>            return Boolean.class;<a name="line.178"></a>
<FONT color="green">179</FONT>        }<a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>        /**<a name="line.181"></a>
<FONT color="green">182</FONT>         * Convert the specified input object into an output object of the<a name="line.182"></a>
<FONT color="green">183</FONT>         * specified type.<a name="line.183"></a>
<FONT color="green">184</FONT>         *<a name="line.184"></a>
<FONT color="green">185</FONT>         * @param type is the type to which this value should be converted. In the<a name="line.185"></a>
<FONT color="green">186</FONT>         *  case of this BooleanConverter class, this value is ignored.<a name="line.186"></a>
<FONT color="green">187</FONT>         *<a name="line.187"></a>
<FONT color="green">188</FONT>         * @param value is the input value to be converted. The toString method<a name="line.188"></a>
<FONT color="green">189</FONT>         *  shall be invoked on this object, and the result compared (ignoring<a name="line.189"></a>
<FONT color="green">190</FONT>         *  case) against the known "true" and "false" string values.<a name="line.190"></a>
<FONT color="green">191</FONT>         *<a name="line.191"></a>
<FONT color="green">192</FONT>         * @return Boolean.TRUE if the value was a recognised "true" value, <a name="line.192"></a>
<FONT color="green">193</FONT>         *  Boolean.FALSE if the value was a recognised "false" value, or<a name="line.193"></a>
<FONT color="green">194</FONT>         *  the default value if the value was not recognised and the constructor<a name="line.194"></a>
<FONT color="green">195</FONT>         *  was provided with a default value.<a name="line.195"></a>
<FONT color="green">196</FONT>         *<a name="line.196"></a>
<FONT color="green">197</FONT>         * @throws Throwable if an error occurs converting to the specified type<a name="line.197"></a>
<FONT color="green">198</FONT>         */<a name="line.198"></a>
<FONT color="green">199</FONT>        protected Object convertToType(Class type, Object value) throws Throwable {<a name="line.199"></a>
<FONT color="green">200</FONT>    <a name="line.200"></a>
<FONT color="green">201</FONT>            // All the values in the trueStrings and falseStrings arrays are<a name="line.201"></a>
<FONT color="green">202</FONT>            // guaranteed to be lower-case. By converting the input value<a name="line.202"></a>
<FONT color="green">203</FONT>            // to lowercase too, we can use the efficient String.equals method<a name="line.203"></a>
<FONT color="green">204</FONT>            // instead of the less-efficient String.equalsIgnoreCase method.<a name="line.204"></a>
<FONT color="green">205</FONT>            String stringValue = value.toString().toLowerCase();<a name="line.205"></a>
<FONT color="green">206</FONT>    <a name="line.206"></a>
<FONT color="green">207</FONT>            for(int i=0; i&lt;trueStrings.length; ++i) {<a name="line.207"></a>
<FONT color="green">208</FONT>                if (trueStrings[i].equals(stringValue)) {<a name="line.208"></a>
<FONT color="green">209</FONT>                    return Boolean.TRUE;<a name="line.209"></a>
<FONT color="green">210</FONT>                }<a name="line.210"></a>
<FONT color="green">211</FONT>            }<a name="line.211"></a>
<FONT color="green">212</FONT>    <a name="line.212"></a>
<FONT color="green">213</FONT>            for(int i=0; i&lt;falseStrings.length; ++i) {<a name="line.213"></a>
<FONT color="green">214</FONT>                if (falseStrings[i].equals(stringValue)) {<a name="line.214"></a>
<FONT color="green">215</FONT>                    return Boolean.FALSE;<a name="line.215"></a>
<FONT color="green">216</FONT>                }<a name="line.216"></a>
<FONT color="green">217</FONT>            }<a name="line.217"></a>
<FONT color="green">218</FONT>            <a name="line.218"></a>
<FONT color="green">219</FONT>            throw new ConversionException("Cna't convert value '" + value + "' to a Boolean");<a name="line.219"></a>
<FONT color="green">220</FONT>        }<a name="line.220"></a>
<FONT color="green">221</FONT>    <a name="line.221"></a>
<FONT color="green">222</FONT>        /**<a name="line.222"></a>
<FONT color="green">223</FONT>         * This method creates a copy of the provided array, and ensures that<a name="line.223"></a>
<FONT color="green">224</FONT>         * all the strings in the newly created array contain only lower-case<a name="line.224"></a>
<FONT color="green">225</FONT>         * letters.<a name="line.225"></a>
<FONT color="green">226</FONT>         * &lt;p&gt;<a name="line.226"></a>
<FONT color="green">227</FONT>         * Using this method to copy string arrays means that changes to the<a name="line.227"></a>
<FONT color="green">228</FONT>         * src array do not modify the dst array.<a name="line.228"></a>
<FONT color="green">229</FONT>         */<a name="line.229"></a>
<FONT color="green">230</FONT>        private static String[] copyStrings(String[] src) {<a name="line.230"></a>
<FONT color="green">231</FONT>            String[] dst = new String[src.length];<a name="line.231"></a>
<FONT color="green">232</FONT>            for(int i=0; i&lt;src.length; ++i) {<a name="line.232"></a>
<FONT color="green">233</FONT>                dst[i] = src[i].toLowerCase();<a name="line.233"></a>
<FONT color="green">234</FONT>            }<a name="line.234"></a>
<FONT color="green">235</FONT>            return dst;<a name="line.235"></a>
<FONT color="green">236</FONT>        }<a name="line.236"></a>
<FONT color="green">237</FONT>    }<a name="line.237"></a>




























































</PRE>
</BODY>
</HTML>
